/*	$Id: entity.h 1097 2010-05-12 02:59:01Z phrakt $	*/
/*
 * Copyright (c) 2003 Jean-Francois Brousseau <phrakt@gmail.com>
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL  DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef _HTTP_ENTITY_H_
#define _HTTP_ENTITY_H_

#include <sys/types.h>

#include <stdint.h>

#include <http/uri.h>
#include <http/msg.h>
#include <http/http.h>


#define HTTP_ENTITY_MAXBUFSIZE		4096

#define HTTP_ENTITY_VOLATILE		0x01


enum http_ent_type {
	HTTP_ENT_FILE,			/* regular file */
	HTTP_ENT_DIR,			/* directory */
	HTTP_ENT_SLNK,			/* symbolic link */
	HTTP_ENT_DYNAMIC,		/* dynamically-generated content */
};


struct http_entity {
	enum http_ent_type   ent_type;
	int                  ent_flags;
	char                *ent_uri;
	char                *ent_path;
	char                *ent_media;
	char                *ent_encoding;

	int                  ent_fd;
	void                *ent_body;
	uint64_t             ent_size;		/* body length */
	uint64_t             ent_inode;		/* inode # (when file or dir) */
	time_t               ent_ctime;
	time_t               ent_atime;
	time_t               ent_mtime;		/* last modification time */

	uid_t                ent_uid;		/* user ID of owner (if any) */
	gid_t                ent_gid;		/* group ID of owner (if any) */
	mode_t               ent_mode;		/* permission mode */
};


http_ent_t*        http_entity_alloc   (enum http_ent_type, const char *, int);
int                http_entity_stat    (http_ent_t *);
ssize_t            http_entity_read    (http_ent_t *, off_t, void *, size_t);
void               http_entity_free    (http_ent_t *);
char*              http_entity_tag     (http_ent_t *, char *, size_t);
int                http_entity_getsize (http_ent_t *, uint64_t *);
enum http_ent_type http_entity_gettype (http_ent_t *);

#endif	/* _HTTP_ENTITY_H_ */
